Amazon IVS Chat Messaging SDK for Android/com.amazonaws.ivs.chat.messaging

Package com.amazonaws.ivs.chat.messaging

Types

Callback

typealias Callback<T> = (T) -> Unit

ChatErrorCodes

object ChatErrorCodes

Error codes returned by chat room.

ChatException

class ChatException( val message: String, val code: Int, val id: String, val requestId: String?) : Exception

ChatRoom

class ChatRoom @JvmOverloads constructor( regionOrUrl: String, tokenProvider: (ChatTokenCallback) -> Unit, maxReconnectAttempts: Int = 3, val id: String = UUID.randomUUID().toString())

Represents IVS chat room connection.

ChatRoomListener

interface ChatRoomListener

Interface for delivering chat room lifecycle events as well as received messages and events.

ChatToken

data class ChatToken( val token: String, val sessionExpirationTime: Date?, val tokenExpirationTime: Date?)

Represents IVS chat token to be used to establish room connection. This should be fetched through your backend for security purposes from IVS Chat API.

ChatTokenCallback

interface ChatTokenCallback

Callback interface used to pass the result of chat token request.

DeleteMessageCallback

typealias DeleteMessageCallback = RequestCallback<DeleteMessageRequest, DeleteMessageEvent>

Interface for reporting delete message request result.

Successful completion of the request is confirmed by receiving a delete message event with matching request id.

Failure of the request is confirmed by receiving a chat error with a matching request id.

DisconnectReason

enum DisconnectReason : Enum<DisconnectReason>

Reason why room transitions to disconnected state.

DisconnectUserCallback

typealias DisconnectUserCallback = RequestCallback<DisconnectUserRequest, DisconnectUserEvent>

Interface for reporting disconnect user request result.

Successful completion of the request is confirmed by receiving a disconnect user event with matching request id.

Failure of the request is confirmed by receiving a chat error with a matching request id.

RequestCallback

interface RequestCallback<Request, Response>

Generic interface for reporting user request completion or rejection by the IVS service.

SendMessageCallback

typealias SendMessageCallback = RequestCallback<SendMessageRequest, ChatMessage>

Interface for reporting send message request result.

Successful completion of the request is confirmed by receiving a chat message with matching request id.

Failure of the request is confirmed by receiving a chat error with a matching request id.